<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>Line2NodeMaterial - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
		<p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Material.html">Material</a> → <a href="NodeMaterial.html">NodeMaterial</a> → </p>
	<h1 translate="no">Line2NodeMaterial</h1>
		<section>
			<header>
				<div class="class-description"><p>This node material can be used to render lines with a size larger than one
by representing them as instanced meshes.</p></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="Line2NodeMaterial" translate="no">new <a href="#Line2NodeMaterial">Line2NodeMaterial</a><span class="signature">( parameters : <span class="param-type">Object</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new node material for wide line rendering.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>parameters</strong>
									</td>
									<td class="description last">
										<p>The configuration parameter.</p>
										<p>Default is <code>{}</code>.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="alphaToCoverage" translate="no">.<a href="#alphaToCoverage">alphaToCoverage</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether alpha to coverage should be used or not.</p>
						<p>Default is <code>true</code>.</p>
					</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="NodeMaterial.html#alphaToCoverage">NodeMaterial#alphaToCoverage</a></dt>
						</dl>
				</div>
				<div class="member">
					<h3 class="name" id="blending" translate="no">.<a href="#blending">blending</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>Blending is set to <code>NoBlending</code> since transparency
is not supported, yet.</p>
						<p>Default is <code>0</code>.</p>
					</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="NodeMaterial.html#blending">NodeMaterial#blending</a></dt>
						</dl>
				</div>
				<div class="member">
					<h3 class="name" id="dashOffset" translate="no">.<a href="#dashOffset">dashOffset</a><span class="type-signature"> : number</span> </h3>
					<div class="description">
						<p>The dash offset.</p>
						<p>Default is <code>0</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="dashScaleNode" translate="no">.<a href="#dashScaleNode">dashScaleNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
					<div class="description">
						<p>Defines the dash scale.</p>
						<p>Default is <code>null</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="dashSizeNode" translate="no">.<a href="#dashSizeNode">dashSizeNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
					<div class="description">
						<p>Defines the dash size.</p>
						<p>Default is <code>null</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="dashed" translate="no">.<a href="#dashed">dashed</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether the lines should be dashed or not.</p>
						<p>Default is <code>false</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="gapSizeNode" translate="no">.<a href="#gapSizeNode">gapSizeNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
					<div class="description">
						<p>Defines the gap size.</p>
						<p>Default is <code>null</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="isLine2NodeMaterial" translate="no">.<a href="#isLine2NodeMaterial">isLine2NodeMaterial</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
					<div class="description">
						<p>This flag can be used for type testing.</p>
						<p>Default is <code>true</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="lineColorNode" translate="no">.<a href="#lineColorNode">lineColorNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;vec3></span> </h3>
					<div class="description">
						<p>Defines the lines color.</p>
						<p>Default is <code>null</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="offsetNode" translate="no">.<a href="#offsetNode">offsetNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
					<div class="description">
						<p>Defines the offset.</p>
						<p>Default is <code>null</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="useColor" translate="no">.<a href="#useColor">useColor</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether vertex colors should be used or not.</p>
						<p>Default is <code>false</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="worldUnits" translate="no">.<a href="#worldUnits">worldUnits</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether the lines should sized in world units or not.
When set to <code>false</code> the unit is pixel.</p>
						<p>Default is <code>false</code>.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="setup" translate="no">.<a href="#setup">setup</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Setups the vertex and fragment stage of this node material.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>builder</strong>
									</td>
									<td class="description last">
										<p>The current node builder.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="NodeMaterial.html#setup">NodeMaterial#setup</a></dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/materials/nodes/Line2NodeMaterial.js" translate="no" target="_blank" rel="noopener">src/materials/nodes/Line2NodeMaterial.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>